CorrelationListCommand Constructor(RasterImage,LeadPoint[],int[],int,int,int)

Summary

Initializes a new CorrelationListCommand with explicit parameters.

Syntax

Objective-C

C++/CLI

Java

Python

public CorrelationListCommand( 
   RasterImage correlationImage, 
   LeadPoint[] points, 
   int[] listIndex, 
   int xStep, 
   int yStep, 
   int threshold 
)

- (instancetype)initWithCorrelationImage:(null_unspecified LTRasterImage *)correlationImage points:(nullable NSArray<NSValue *> *)points listIndex:(NSUInteger *)listIndex xStep:(NSUInteger)xStep yStep:(NSUInteger)yStep threshold:(NSUInteger)threshold NS_DESIGNATED_INITIALIZER;

public CorrelationListCommand( 
   RasterImage correlationImage, 
   LeadPoint[] points, 
   int[] listIndex, 
   int xStep, 
   int yStep, 
   int threshold 
);

public: 
CorrelationListCommand(  
   RasterImage^ correlationImage, 
   array<LeadPoint>^ points, 
   array<int>^ listIndex, 
   int xStep, 
   int yStep, 
   int threshold 
)

__init__(self,correlationImage,points,listIndex,xStep,yStep,threshold) # Overloaded constructor

Parameters

correlationImage
RasterImage object that references the image(s) for which to search.

points
Array of LeadPoint objects to be updated with the starting points of the correlated areas.

listIndex
Array of integers to be updated with the indices of the images that match correlated areas.

xStep
Step size in the X direction (along image width), in pixels. For best results, use 1.

yStep
Step size in the Y direction (along image height), in pixels. For best results, use 1.

threshold
Value that indicates the correlation threshold, which is a measure of the association necessary for two areas to be considered to be correlated. If the correlation value between an image in the list and an area in the reference image is less than the correlation threshold they are uncorrelated. Valid values range from 0 (zero resemblance) to 100 (perfect resemblance).

Example

Run the CorrelationListCommand on an image

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Core; 
 
public void CorrelationListConstructorExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "clean.tif")); 
 
   CopyRectangleCommand copyRectangle = new CopyRectangleCommand(); 
 
   LeadRect rc_cor = new LeadRect(327, 378, 22, 28); 
   copyRectangle.Rectangle = rc_cor; 
   copyRectangle.Run(image); 
   RasterImage correlationImage = copyRectangle.DestinationImage.Clone(); 
 
   rc_cor = new LeadRect(283, 378, 22, 28); 
   copyRectangle.Rectangle = rc_cor; 
   copyRectangle.Run(image); 
   correlationImage.AddPage(copyRectangle.DestinationImage.Clone()); 
 
   LeadPoint[] points = new LeadPoint[30]; 
   int[] listIndex = new int[30]; 
 
   CorrelationListCommand command = new CorrelationListCommand(correlationImage, points, listIndex, 1, 1, 90); 
   command.Run(image); 
   Assert.IsTrue(command.NumberOfPoints == points.Length); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms

Reference

CorrelationListCommand Class

CorrelationListCommand Members

Overload List

Download our FREE evaluation

Help Version 22.0.2023.11.1

Leadtools.ImageProcessing.Core Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.Core Namespace

Assemblies